Expand description

This library makes it easy to read passwords in a console application on all platforms, Unix, Windows, WASM, etc.

Here’s how you can read a password:

let password = rpassword::read_password().unwrap();
println!("Your password is {}", password);

You can also prompt for a password:

let password = rpassword::prompt_password("Your password: ").unwrap();
println!("Your password is {}", password);

Finally, in unit tests, you might want to pass a Cursor, which implements BufRead. In that case, you can use read_password_from_bufread and prompt_password_from_bufread:

use std::io::Cursor;

let mut mock_input = Cursor::new("my-password\n".as_bytes().to_owned());
let password = rpassword::read_password_from_bufread(&mut mock_input).unwrap();
println!("Your password is {}", password);

let mut mock_input = Cursor::new("my-password\n".as_bytes().to_owned());
let mut mock_output = Cursor::new(Vec::new());
let password = rpassword::prompt_password_from_bufread(&mut mock_input, &mut mock_output, "Your password: ").unwrap();
println!("Your password is {}", password);

Functions

Prompts on the TTY and then reads a password from TTY

Prompts on the TTY and then reads a password from anything that implements BufRead

Reads a password from the TTY

Reads a password from anything that implements BufRead